Represents a web page consisting of a key for access and an url. This class can be used
together with the class LSANamedList and implemets the AnyItem interface.
- Version:
-
1.2, 21.MAR.2000
- History:
Public Property Set Key AsString
Sets the description for an web page and checks on the us of not allowed charakters
e.g. "Homepage" for the homepage url of a company
Public Property Get Key AsString
Public Property Set URL AsString
Sets the URL of the web page and checks on not allowed chars.
Public Property Get URL AsString
Public Property Set Delimiter AsString
When the object is imploded to a serial data string this character will be used as seperator.
If the programmer doesn't set a delimiter a default value will be delivered by the class.
Public Property Get Delimiter AsString
Public Property Set NotAllowedChars AsVariant
These characters are not allowed to be use in the key property
Public Property Get NotAllowedChars AsVariant
Public Property Get DisplayFormat AsString
The display format is a rule for formatting the object data when
the property 'Formatted' is used. The values of the constants
DefaultKeyName and DefaultURLName has to be used to form the format
Public Property Set DisplayFormat AsString
Public Property Get Formatted AsString
Formats the object's data in a user defined way
New
Public Sub New(newKey As String,newURL As String)
Sets the properties Key and URL with the parameter values.
Default values for the properties Delimiter, NotAllowedChars and DisplayFormat are set.
- Parameters:
| newKey | String | the key with which the web page can be reached in a list
|
| newURL | String | the URL address of the web page
|
Delete
Public Sub Delete
Implode
Public Function Implode As String
Writes the data of the object to a serialized data string.
The string should is of the form: ~~~~, where
the character "~" is the delimiter
- Returns:
| String | serial data string representing the object
|
Explode
Public Sub Explode(serializedObj As String)
Transforms a string build by the implode method in its components.
The string should be in the form ~~ ~ or
~~~~, where "~" is the attribute delimiter.
After explode the old values are reseted
- Parameters:
| serializedObj | String | String of the format as delivered by the implode method
|
- Errors:
| ErrDataDoesntCorrespondToObject | |
Validate
Public Sub Validate
The validate method checks that the properties "Key" and "URL"
aren't empty.
- Errors:
| ErrPageNameEmpty | |
| ErrURLEmpty | |
Clear
Public Sub Clear
The method clears the values of the e-mail item object. After the usage of clear the
method IsEmptyInstance will deliver true as return value.
IsEmptyInstance
Public Function IsEmptyInstance As Integer
Checks if the attribute Key and Url are set to none empty strings ("").
- Returns:
| boolean | true, if attributes are empty
|
CompareTo
Public Function CompareTo(CompItem As LSAWebPageItem) As Integer
Compares the properties Key and URL of the WebPageItem object.
- Parameters:
| compItem | LSAWebPageItem | the object to compare against
|
- Returns:
| boolean | true, if object have same attributes
|
hasAttributeChanged
Public Function hasAttributeChanged(attrName As String) As Integer
Checks if the attribute with the name attrName has heen changed
- Parameters:
| attrName | String | the name of the attribute to check
|
- Returns:
| boolean | true, if the attribute has changed
|
hasChanged
Public Function hasChanged As Integer
Checks one of the objects attributes has been changed
| Top | LotusScript Doc |
| © Lotus Professional Services |
| generated on : 05-Apr-01 8:40:00 AM |